home *** CD-ROM | disk | FTP | other *** search
/ Web Page Construction Kit 3.0 / Web Page Construction Kit 3.0.iso / pc / source / 3rdparty / cgi / selena / outlet / install.txt < prev    next >
Encoding:
Text File  |  1996-08-02  |  10.7 KB  |  243 lines
  1.                              BASIC INFORMATION
  2.  
  3. Name: Selena Sol's Electronic Outlet (HTML Version)
  4. Version: 3.0
  5. Last Modified: 09-01-96
  6.  
  7.                                DESCRIPTION
  8.  
  9. This script and associated files allows one to sell one's inventory
  10. on the web.  The interface is built primarily with HTML pages that are
  11. specifically formatted with script-understanbdable tags so that the script
  12. can keep track of users and their unique shopping carts.
  13.  
  14.                           COPYRIGHT INFORMATION
  15.  
  16. This application was written by Selena Sol (selena@eff.org,
  17. http://www.eff.org/~erict) having been inspired by countless other Perl
  18. authors.  Feel free to copy, cite, reference, sample, borrow, resell or
  19. plagiarize the contents.  However, if you don't mind, please let me know
  20. where it goes so that I can at least watch and take part in the
  21. development of the memes. Information wants to be free, support public
  22. domain freware.  Donations are appreciated and will be spent on further
  23. upgrades and other public domain scripts.
  24.  
  25. Finally, PLEASE SEND WORKING URL's to selena@eff.org.  I maintain a list
  26. of implementations around the world.
  27.  
  28.                  SUPPORT
  29.  
  30. This script comes with no gaurentees or warranties.  I am not a
  31. programming professional.  I am a web-hobbiest and my scripts are
  32. continually evolving as I learn more. Don't expect the scripts to be
  33. perfect. 
  34.  
  35. Bug reports are greatly appreciated but installation support is
  36. extremely discouraged. I have attempted to include as much information as
  37. I could think of in this README and in the Customization and Installation
  38. FAQ available at http://www.eff.org/~erict/Scripts/.  Please try ALL
  39. available sources of information BEFORE you email me.  But if you must,
  40. make sure to include the following bits of information (I may not respond
  41. to your email if you do not answer ALL of the following questions):
  42.  
  43. 1. What type of Web server are you running?
  44. 2. What type of Operating System is the Web server running on?
  45.  
  46. 3. What is the "exact" error message from the Web?
  47. 4. What is the "exact" error message in your web server's error log?
  48. 5. What is the "exact" error message you receive when running the script
  49.        from the command line.
  50.  
  51. 6. Are you running this script on an ISP?  If so, what is the email
  52.        address of the Sysadmin there?
  53. 7. Are you using a virtual server setup?  If so, what is the root path set
  54.        in your Web server's environment?
  55.  
  56. 8. In which directory is the Perl interpreter located?
  57. 9. In which directory is sendmail located (if you are using a script which
  58.        demands use of sendmail)
  59.  
  60. Again, I MAY NOT ANSWER YOUR QUESTION unless you have answered all nine of
  61. these questions.
  62.  
  63.                 BASIC INSTALLATION (DOWNLOADING THE SCRIPT)
  64.  
  65. It is recommended that you point your Web browser to "Selena Sol's Script
  66. Archive" to get the latest version of this script.  The Script Archive is
  67. located at the following URL:
  68.  
  69.                     http://www.eff.org/~erict/Scripts/
  70.  
  71. From the "Script Archive" frontpage follow the hyperlinks to the detailed
  72. page dedicated to this script.  Then click on the hyperlink "Download the
  73. scripts as a single tar file".
  74.  
  75.                 BASIC INSTALLATION (UNARCHIVING THE APPLICATION)
  76.  
  77. Once you have downloaded the TAR file (a single file containing all
  78. associated files in their relative positions under the root directory),
  79. transfer the TAR file to an executable directory on your web server and
  80. untar them.  On UNIX systems, you may type the following at the
  81. command line:
  82.  
  83.                           tar xvfp filename.tar
  84.  
  85.        (If you are using a non-UNIX Operating System, you may 
  86.        download a TAR/UNTAR program by pointing your Web browser
  87.        to http://www.shareware.com).
  88.  
  89.                  BASIC INSTALLATION (SETTING PERMISSIONS)
  90.  
  91. Your Web server must have permission to read, write or execute as needed.
  92. Each sub-directory and file in the application has its own correct
  93. permissions level associated with it.  Once you have unarchived (UNTAR)
  94. the application, you must then set the correct permissions.  On UNIX
  95. systems, you will use the "chmod" command.   The following table is a
  96. quick guide to setting permissions for UNIX servers.
  97.  
  98.     PERMISSION    COMMAND
  99.     rwxrwxrwx     chmod 777 filename        
  100.     rwxrwxr-x    chmod 775 filename
  101.     rwxr-xr-x    chmod 755 filename
  102.     rw-rw-r--    chmod 664 filename
  103.     rw-r--r--    chmod 644 filename
  104.  
  105.     Note: Not setting your permissions correctly is the 
  106.     NUMBER 1 reason why installations fail.  Take time to 
  107.     get this right.
  108.  
  109. The actual permissions required for the subdirectories and files used by
  110. this application are listed in the next section.
  111.  
  112.          BASIC INSTALLATION (FILES, DIRECTORIES, AND PERMISSIONS)
  113.  
  114. The TAR file will then expand into a root directory called Html_web_store.
  115. Html_web_store will contain several sub-directories and several files.  
  116. The diagram below depicts the directory structure as well as the
  117. permissions which must be applied to the files and subdirectories used by
  118. the application.
  119.  
  120. Html_web_store Root Directory (drwxr-xr-x)
  121.    |____Html Sub-directory (drwxr-xr-x)
  122.    |       |____frames.html (-rw-r--r--)
  123.    |       |____frontpage.html (-rw-r--r--)
  124.    |       |____number.html (-rw-r--r--)
  125.    |       |____outlet_frontpage.html (-rw-r--r--)
  126.    |       |____outlet_order_form.html (-rw-r--r--)
  127.    |       |____table_of_contents.html (-rw-r--r--)
  128.    |       |____vowel.html (-rw-r--r--)
  129.    |____Library Sub-directory(drwxr-xr-x)
  130.    |       |____cgi-lib.pl (-rw-r--r--)
  131.    |       |____cgi-lib.sol (-rw-r--r--)
  132.    |       |____mail-lib.pl (-rw-r--r--)
  133.    |____User_carts Sub-directory (drwxrwxrwx)
  134.    |       |____html_web_store.counter (-rw-rw-rw-)
  135.    |____html_web_store.cgi (-rwxr-xr-x)
  136.    |____html_web_store.setup (-rw-r--r--)
  137.  
  138. Html_web_store - This is the application's root directory.  The Web server
  139.     must have read and execute privileges
  140.  
  141.  
  142. Html - This sub-directory is used to hold various HTML documents that are
  143.      used by html_web_store.cgi to create some GUI elements.  The
  144.     subdirectory must be readable and executable by the web server and
  145.     contains seven "Example" HTML files: frames.html, frontpage.html,
  146.     number.html, outlet_frontpage.html, outlet_order_form.html,
  147.     table_of_contents.html, and vowel.html. Each of these files
  148.     must be readable by the web server.
  149.  
  150.     frames.html
  151.     frontpage.html
  152.     number.html
  153.     outlet_frontpage.html
  154.     outlet_order_form.html
  155.     table_of_contents.html
  156.     vowel.html
  157.  
  158. Library - This sub-directory is used to hold the associated library files
  159.     used by this application.  The subdirectory must be readable and
  160.     executable by the web server and contains nine library files
  161.     which must all be readable by the web server: cgi-lib.pl,
  162.     cgi-lib.sol, mail-lib.pl.
  163.  
  164.     Each library file is individually commented, so i will only give
  165.     them cursory coverage here.  cgi-lib.pl is used to read and parse
  166.     incoming form data.  cgi-lib.sol is used to manipulate counter
  167.     files and create lock files when necessary.  mail-lib.pl is used
  168.     to send email to the store admin when orders are placed.  You must
  169.     define the local path of sendmail at line 42 of this library.  If
  170.     you are using an NT server and cannot use sendmail at all, you
  171.     must replace this version with the SMTP version available at
  172.     http://www.eff.org/~erict/Scripts/
  173.  
  174. User_carts - This sub-directory is used to store the actual shopping carts
  175.     used by people browsing your store.  The subdirectory should be
  176.     readable, writable and executable by the web server which will
  177.         continually fill the sub directory up and prune it automatically
  178.         in the course of usage. Initially, this directory will contain
  179.         only web_store.counter which should be readable and writable by
  180.     the web server.
  181.  
  182.     html_web_store.counter is the counter file which will be used to assign
  183.     unique shopping cart id numbers for items within client's carts.
  184.     Initially, this file should simply have a one as the only line in
  185.     the file.  the script will automatically increment this as needed.
  186.  
  187. html_web_store.cgi - is the main script whjich generates the GUI for the
  188.     online store.  it must be readable and executable by the web
  189.     server.
  190.  
  191. html_web_store.setup - is a file which contains server specific options
  192.     and variables which must be defined for html_web_store.cgi to run.
  193.     It must be readable by the web server.
  194.  
  195.           BASIC INSTALLATION (SETUP FILES - HTML_WEB_STORE.SETUP)
  196.  
  197. $counter_file is the location of the counterfile used to assign unique
  198.     numbers to every item added to the shopping cart.
  199. $main_script is the local path of html_web_store.cgi
  200. $main_script_url is the URL of html_web_store.cgi
  201. $data_directory is the local path of the Databases directory.
  202. $order_form is the name of the HTML order form that you will use when
  203.     someone is ready to place their order.
  204. $admin_email is the email addres of the person who should receive the
  205.     order submitted.
  206. $email_subject is the subject of the email regarding an order
  207. $cart_directory is the directory where all of the user shopping carts
  208.      will be stored.  The script will create the files on its own.  You
  209.     need only make the directory readable, writable and executable by
  210.     the web server.
  211. $html_directory is the root of your HTML documents.  In the
  212.     distribution, all HTML are contained in a subdirectory of this
  213.     one...but it does not matter where your HTML is so long as you
  214.     include the entire path.
  215. $cgi_lib_pl is the location of cgi_lib_pl
  216. $cgi_lib_sol is the location of cgi_lib_sol
  217. $mail-lib.pl is the location of mail-lib.pl
  218. $frontpage_file is the location of the very first HTML page that you
  219.     want displayed when a new client enters the store.
  220. @display_fileds is the array containing all the shopping cart database
  221.     fields that you want displayed when the user hits the view/modify
  222.     button.
  223. @display_numbers are the corresponding array numbers of those within the
  224.     array (Remember that array counting starts at 0 not 1)
  225. $price_number is specifically the array number of price.  We need to be
  226.     able to identify this in order to make price calculations.
  227. @email_numbers are the array elements that you want sent in the email to
  228.     the admin so that she knows what items have been ordered.
  229. %order_form_array is the associative array containing the variable names
  230.     ans their associated Display Names.  Note, the preceeding numbers (ie
  231.     01-, 02-, 03-) are used to "force" an order.  because associative
  232.     arrays use hash tables, the order cannot be determined unless you
  233.     sort them with numbers as shown here.  This is not mandatory, but
  234.     good naming of variables will make the display nicer on the
  235.     screen.
  236.  
  237.                RUNNING THE SCRIPT
  238.  
  239. This script should be run by pointing your browser to html_web_store.cgi.
  240. For example, you might use a URL such as:
  241.  
  242.     http://www.foobar.com/cgi-bin/Html_web_store/html_web_store.cgi
  243.